<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<html lang="en-us" xml:lang="en-us">
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="DC.Type" content="topic">
  <meta name="DC.Title" content="Step 1: Registering a Redis Cluster">
  <meta name="product" content="">
  <meta name="DC.Relation" scheme="URI" content="en-us_topic_0000001839153129.html">
  <meta name="prodname" content="">
  <meta name="version" content="">
  <meta name="brand" content="30-OceanProtect Appliance 1.5.0-1.6.0 Help Center">
  <meta name="DC.Publisher" content="20240608">
  <meta name="DC.Format" content="XHTML">
  <meta name="DC.Identifier" content="EN-US_TOPIC_0000001839153085">
  <meta name="DC.Language" content="en-us">
  <link rel="stylesheet" type="text/css" href="public_sys-resources/commonltr.css">
  <title>Step 1: Registering a Redis Cluster</title>
 </head>
 <body style="clear:both; padding-left:10px; padding-top:5px; padding-right:5px; padding-bottom:5px">
  <a name="EN-US_TOPIC_0000001839153085"></a><a name="EN-US_TOPIC_0000001839153085"></a>
  <h1 class="topictitle1">Step 1: Registering a Redis Cluster</h1>
  <div>
   <p>Before backing up and restoring a Redis cluster, register the Redis cluster with the <span>product</span>.</p>
   <div class="section">
    <h4 class="sectiontitle">Prerequisites</h4>
    <p>A Redis host has been added.</p>
   </div>
   <div class="section">
    <h4 class="sectiontitle">Procedure</h4>
    <ol>
     <li><span>Choose <span class="uicontrol" id="EN-US_TOPIC_0000001839153085__en-us_topic_0000001839142377_uicontrol465185015397"><b><span id="EN-US_TOPIC_0000001839153085__en-us_topic_0000001839142377_text265115073919"><strong>Protection</strong></span> &gt; Big Data &gt; Redis</b></span>.</span></li>
     <li><span>On the <span class="uicontrol"><b><span><strong>Cluster</strong></span></b></span> page, click <span class="uicontrol"><b><span><strong>Register</strong></span></b></span> to register a Redis cluster.</span><p></p>
      <ol type="a">
       <li>Enter the Redis cluster name.</li>
       <li>Click <span class="uicontrol"><b>Add</b></span> to add all nodes in the Redis cluster. <a href="#EN-US_TOPIC_0000001839153085__table196232217593">Table 1</a> describes the related parameters. 
        <div class="tablenoborder">
         <a name="EN-US_TOPIC_0000001839153085__table196232217593"></a><a name="table196232217593"></a>
         <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001839153085__table196232217593" frame="border" border="1" rules="all">
          <caption>
           <b>Table 1 </b>Parameters for adding Redis nodes
          </caption>
          <colgroup>
           <col style="width:25.03%">
           <col style="width:74.97%">
          </colgroup>
          <thead align="left">
           <tr>
            <th align="left" class="cellrowborder" valign="top" width="25.03%" id="mcps1.3.3.2.2.2.1.2.3.2.3.1.1"><p>Parameter</p></th>
            <th align="left" class="cellrowborder" valign="top" width="74.97%" id="mcps1.3.3.2.2.2.1.2.3.2.3.1.2"><p>Description</p></th>
           </tr>
          </thead>
          <tbody>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>Hosts</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>Select the registered Redis host.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>Client installation path</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>Redis client installation path.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>Service IP Address</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>Redis service IP address.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>Port</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>Port number of the Redis instance.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>Authentication Method</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>Configure the authentication mode for communication between the Redis cluster and the <span>product</span>. Set this parameter based on the authentication mode enabled for the Redis cluster.</p>
             <ul>
              <li><span><strong>OS Authentication</strong></span>: Select this authentication mode when Kerberos authentication is disabled for the Redis cluster.</li>
              <li><span><strong>Kerberos Authentication</strong></span>: Select this authentication mode when Kerberos authentication is enabled for the Redis cluster. The Kerberos protocol is used for identity authentication between the Redis cluster and the <span>product</span>.</li>
             </ul></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>Kerberos</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>This parameter is mandatory only when <span class="uicontrol"><b><span><strong>Authentication Method</strong></span></b></span> is set to <span class="uicontrol"><b><span><strong>Kerberos Authentication</strong></span></b></span>.</p> <p>Select the created Kerberos authentication. When you register a Redis cluster for the first time, click <span class="uicontrol"><b><span><strong>Create</strong></span></b></span> and configure Kerberos authentication parameters. <a href="#EN-US_TOPIC_0000001839153085__table93413354118">Table 2</a> describes the related parameters.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="25.03%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.1 "><p><span><strong>SSL Channel Encryption</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="74.97%" headers="mcps1.3.3.2.2.2.1.2.3.2.3.1.2 "><p>You are advised to enable channel encryption when important or sensitive information exists in Redis. Channel encryption encrypts data during data transmission, which deteriorates performance.</p></td>
           </tr>
          </tbody>
         </table>
        </div> <p>Set Kerberos authentication parameters as described in <a href="#EN-US_TOPIC_0000001839153085__table93413354118">Table 2</a>.</p>
        <div class="tablenoborder">
         <a name="EN-US_TOPIC_0000001839153085__table93413354118"></a><a name="table93413354118"></a>
         <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001839153085__table93413354118" frame="border" border="1" rules="all">
          <caption>
           <b>Table 2 </b>Kerberos authentication parameters
          </caption>
          <colgroup>
           <col style="width:23.24%">
           <col style="width:76.75999999999999%">
          </colgroup>
          <thead align="left">
           <tr>
            <th align="left" class="cellrowborder" valign="top" width="23.24%" id="mcps1.3.3.2.2.2.1.2.5.2.3.1.1"><p>Parameter</p></th>
            <th align="left" class="cellrowborder" valign="top" width="76.75999999999999%" id="mcps1.3.3.2.2.2.1.2.5.2.3.1.2"><p>Description</p></th>
           </tr>
          </thead>
          <tbody>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Name</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 "><p>User-defined Kerberos authentication name.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Principal Name</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 "><p>Principal name of Kerberos authentication.</p>
             <div class="note">
              <span class="notetitle"> NOTE: </span>
              <div class="notebody">
               <p>Set this parameter to the principal name configured on the Kerberos server, and ensure that the principal has read and management permissions on the resources to be accessed.</p>
              </div>
             </div></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Configuration Mode</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 ">
             <div class="p">
              Kerberos authentication mode, which must be the same as that configured on the Kerberos server. The following authentication modes are supported:
              <ul>
               <li><span><strong>Password</strong></span>: Use the principal name and password for identity authentication.</li>
               <li><span><strong>Keytab File</strong></span>: Use the principal name and keytab file for identity authentication.</li>
              </ul>
             </div></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Config File</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 "><p><span class="filepath"><b>.conf</b></span> configuration file (for example, <strong>krb5.conf</strong>) used during Kerberos authentication. Contact the Kerberos server administrator to obtain the file from the Kerberos server and click <span><img src="en-us_image_0000001792354022.png"></span> to upload it to the <span>product</span>.</p>
             <div class="p">
              Due to problems in Kerberos, if <span class="uicontrol"><b>renew_lifetime</b></span> exists in the configuration file, comment it out. Otherwise, the registration may fail. Example:
              <pre class="screen">#renew_lifetime = 7d</pre>
             </div></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Password</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 "><p>This parameter is mandatory only when <span class="uicontrol"><b><span><strong>Configuration Mode</strong></span></b></span> is set to <span class="uicontrol"><b><span><strong>Password</strong></span></b></span>.</p> <p>Set this parameter to the password of <span class="uicontrol"><b><span><strong>Principal Name</strong></span></b></span>.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Confirm Password</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 "><p>Confirm the password of <span class="uicontrol"><b><span><strong>Principal Name</strong></span></b></span>.</p></td>
           </tr>
           <tr>
            <td class="cellrowborder" valign="top" width="23.24%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.1 "><p><span><strong>Keytab File</strong></span></p></td>
            <td class="cellrowborder" valign="top" width="76.75999999999999%" headers="mcps1.3.3.2.2.2.1.2.5.2.3.1.2 "><p>This parameter is mandatory only when <span class="uicontrol"><b><span><strong>Configuration Mode</strong></span></b></span> is set to <span class="uicontrol"><b><span><strong>Keytab File</strong></span></b></span>. <span class="filepath"><b>.keytab</b></span> configuration file (for example, <strong>krb5.keytab</strong>) used during Kerberos authentication.</p> <p>Contact the Kerberos server administrator to obtain the file from the Kerberos server and click <span><img src="en-us_image_0000001839153145.png"></span> to upload it to the <span>product</span>.</p></td>
           </tr>
          </tbody>
         </table>
        </div></li>
      </ol> <p></p></li>
     <li><span>Click <span class="uicontrol"><b><span><strong>OK</strong></span></b></span>.</span></li>
    </ol>
   </div>
   <p></p>
  </div>
  <div>
   <div class="familylinks">
    <div class="parentlink">
     <strong>Parent topic:</strong> <a href="en-us_topic_0000001839153129.html">Backing Up a Redis Cluster</a>
    </div>
   </div>
  </div>
 </body>
</html>